-
-
Notifications
You must be signed in to change notification settings - Fork 257
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add installation guide #818
docs: add installation guide #818
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are missing some content here.
So the thing is that there are 2 ways (actually 3 😄 ) to install AsyncAPI generator
- generator is a library that anyone can also use in their Nodejs applications. Like we do in our server-api -> https://github.com/asyncapi/server-api/blob/master/package.json#L49
So you use it as library, not its CLI. You install it likenpm install @asyncapi/generator
, not with-g
flag, as you do not install it globally but only inside your project. Sample code -> https://github.com/asyncapi/server-api/blob/master/src/services/generator.service.ts#L18-L29. **We need this covered in this document too, I mean info that it is a library and how to install in a project (same npm and nodejs restrictions) - generator also contains cli. Atm PR to introduce generator in
@asyncapi/cli
is still not merged. So I suggest, for now, forget about it. Do not mention how to install@asyncapi/cli
(also remove MacOS instructions as they are valid only for AsyncAPI CLI, not generator CLI). So focus only on@asyncapi/generator
please
(actually 3 😄 )
it would be nifty to mention that if someone wants to use Generator CLI in CI/CD to automate generation (many people do it), then whey should just install generator CLI in their CI/CD, but in case of GitHub Actions, they can use https://github.com/marketplace/actions/generator-for-asyncapi-documents
I hope I'm not confusing, please lemme know if you need more help
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few minors
also please add these new docs here https://github.com/asyncapi/generator/blob/master/docs/README.md
After Intro, and 2nd and 3rd doc
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚀
@alequetzalli wanna have a final look before I merge?
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm 🚀
@alequetzalli wanna approve before merge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
MERGING TIME BABY 🚢 🚢 🚢 🚢 🚢 🚢
71b823a
Kudos, SonarCloud Quality Gate passed!
|
/rtm |
🎉 This PR is included in version 1.9.14 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
This is the ag CLI installation and upgrade guide.
Related issue(s)
Fixes #810